home *** CD-ROM | disk | FTP | other *** search
/ Amiga Format CD 46 / Amiga Format CD46 (1999-10-20)(Future Publishing)(GB)[!][issue 1999-12].iso / -in_the_mag- / reader_requests / scilab / man / man-part1 / cat3 / getvalue.3 < prev    next >
Text File  |  1999-09-16  |  2KB  |  133 lines
  1.  
  2.  
  3.  
  4. getvalue(1)                    Scilab Function                    getvalue(1)
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11. NAME
  12.   getvalue - xwindow dialog for data acquisition
  13.  
  14. CALLING SEQUENCE
  15.   [ok,x1,..,x11]=getvalue(desc,labels,typ,ini)
  16.  
  17. PARAMETERS
  18.  
  19.   desc : column vector of strings, dialog general comment
  20.  
  21.   labels
  22.        : n column vector of strings, labels(i) is the label of the ith
  23.        required value
  24.  
  25.   typ  : list(typ1,dim1,..,typn,dimn)
  26.  
  27.        typi
  28.          : defines the type of the ith value, may have the following values:
  29.  
  30.          "mat"
  31.            : for constant matrix
  32.  
  33.          "col"
  34.            : for constant column vector
  35.  
  36.          "row"
  37.            : for constant row vector
  38.  
  39.          "vec"
  40.            : for  constant vector
  41.  
  42.          "str"
  43.            : for string
  44.  
  45.          "lis"
  46.            : for list
  47.  
  48.        dimi
  49.          : defines the size of the ith value it must be a integer or a 2-
  50.          vector of integer, -1 stands for undefined dimension
  51.  
  52.   ini  : n column vector of strings, ini(i) gives the suggested response for
  53.        the ith required value
  54.  
  55.   ok   : boolean ,%t if ok button pressed, %f if cancel button pressed
  56.  
  57.   xi   : contains the ith value if ok=%t
  58.  
  59.  
  60.  
  61. DESCRIPTION
  62.   This function encapsulate x_mdialog function with error checking, evalua-
  63.   tion of numerical response, ...
  64.  
  65.  
  66.  
  67. REMARKS
  68.   All valid expressions can be used as answers; for matrices and vectors get-
  69.   values automatically adds [ ] around the given answer before numeric
  70.   evaluation.
  71.  
  72. EXAMPLE
  73.   labels=["magnitude";"frequency";"phase    "];
  74.   [ok,mag,freq,ph]=getvalue("define sine signal",labels,...
  75.        list("vec",1,"vec",1,"vec",1),["0.85";"10^2";"%pi/3"])
  76.  
  77. SEE ALSO
  78.   x_mdialog, x_matrix, x_dialog
  79.  
  80. AUTHOR
  81.   S. Steer
  82.  
  83.  
  84.  
  85.  
  86.  
  87.  
  88.  
  89.  
  90.  
  91.  
  92.  
  93.  
  94.  
  95.  
  96.  
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.  
  130.  
  131.  
  132.  
  133.